home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkListSearch.z / VkListSearch
Encoding:
Text File  |  1998-10-20  |  6.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))                                              VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkListSearch - A utility class for implementing incremental search in a
  10.      list
  11.  
  12. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  13.      #include <Vk/VkListSearch.h>
  14.  
  15. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  16.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  17.            VkListSearch(Widget list, Widget text,
  18.                         Boolean usingVkList = False);
  19.            ~VkListSearch();
  20.  
  21.  
  22.    CCCCoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn
  23.            void setData(caddr_t d);
  24.  
  25.  
  26.            void setListSetPos(VkListSetPosProc p);
  27.  
  28.  
  29.            void setListSetMiddlePos(VkListSetMiddlePosProc p);
  30.  
  31.  
  32.            void setListIsViewablePos(VkListIsViewablePosProc p);
  33.  
  34.  
  35.            void setListDeselectAllItems(VkListDeselectAllItemsProc p);
  36.  
  37.  
  38.            void setListSelectPos(VkListSelectPosProc p);
  39.  
  40.  
  41. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  42.           VkListSearch is a utility class for implementing incremental search
  43.           within a Motif scrolled list (XmScrolledList or SgScrolledList) or
  44.           within a custom list-like widget.  It takes a Motif text widget and
  45.           a Motif list, and transparently implements the search behavior.
  46.  
  47.  
  48.  
  49. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  50.    VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh(((())))
  51.            VkListSearch(Widget list, Widget text,
  52.                         Boolean usingVkList = False);
  53.            virtual void ~VkListSearch(void);
  54.  
  55.  
  56.           VkListSearch activates the search behavior for the text widget and
  57.           the list widget.  The usingVkList parameter should be set to True
  58.           when using SgList instead of XmList.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))                                              VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))
  71.  
  72.  
  73.  
  74.           By default, the list manipulation routines will be automatically
  75.           setup for XmList or SgList.  When using a different kind of list, it
  76.           is necessary to specify routines for manipulating the list.  Use the
  77.           typedefs VkListSetPosProc, VkListSetMiddlePosProc,
  78.           VkListIsViewablePosProc, VkListDeselectAllItemsProc, and
  79.           VkListSelectPosProc to create appropriate functions, and use the
  80.           methods setListSetPos, setListSetMiddlePos, setListIsViewablePos,
  81.           setListDeselectAllItems, and setListSelectPos to set them.
  82.  
  83.  
  84.    sssseeeettttDDDDaaaattttaaaa(((())))
  85.            void setData(caddr_t d);
  86.  
  87.  
  88.           This function sets the clientData sent to the list manipulator
  89.           functions.  It is ignored when using XmList or SgList.
  90.  
  91.    sssseeeettttLLLLiiiissssttttSSSSeeeettttPPPPoooossss(((())))
  92.            void setListSetPos(VkListSetPosProc p);
  93.  
  94.  
  95.           This function sets the function used to set the top list position.
  96.           The function should behave like XmListSetPos.
  97.  
  98.    sssseeeettttLLLLiiiissssttttSSSSeeeettttMMMMiiiiddddddddlllleeeePPPPoooossss(((())))
  99.            void setListSetMiddlePos(VkListSetMiddlePosProc p);
  100.  
  101.  
  102.           This function sets the function used to set the middle list
  103.           position.
  104.  
  105.    sssseeeettttLLLLiiiissssttttIIIIssssVVVViiiieeeewwwwaaaabbbblllleeeePPPPoooossss(((())))
  106.            void setListIsViewablePos(VkListIsViewablePosProc p);
  107.  
  108.  
  109.           This function sets the function used to see if a list position is
  110.           visible.
  111.  
  112.    sssseeeettttLLLLiiiissssttttDDDDeeeesssseeeelllleeeeccccttttAAAAllllllllIIIItttteeeemmmmssss(((())))
  113.            void setListDeselectAllItems(VkListDeselectAllItemsProc p);
  114.  
  115.  
  116.           This function sets the function used to deselect all items in the
  117.           list.  The function should behave like XmListDeselectAllItems.
  118.  
  119.    sssseeeettttLLLLiiiissssttttSSSSeeeelllleeeeccccttttPPPPoooossss(((())))
  120.            void setListSelectPos(VkListSelectPosProc p);
  121.  
  122.  
  123.           This function sets the function used to select a list item.  The
  124.           function should behave like XmListSelectPos.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))                                              VVVVkkkkLLLLiiiissssttttSSSSeeeeaaaarrrrcccchhhh((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  141.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  142.           setDefaultResources(), getResources(), manage(), unmanage(),
  143.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  144.  
  145.  
  146.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  147.           callCallbacks(), addCallback(), removeCallback(),
  148.           removeAllCallbacks()
  149.  
  150.  
  151. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  152.      VkComponent
  153.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  154.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  155.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  156.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.